docs: accuracy fixes and UX quick wins#4
Merged
Merged
Conversation
… report formats, exit codes, OF bindings - Merge reference/exit-codes.md into cli/exit-codes.md: full table, per-command matrix, why-exit-1 explanation, CI YAML example, stability guarantee. Deleted the redundant reference page (sidebar update needed separately). - Expand how-flaglint-works.md: import-verified concept with false-positive example, three-phase pipeline explanation, what FlagLint does not do. - Expand troubleshooting.md: 4 items → 8 items covering 0-flags-detected, config-not-found, React-not-automigrated, apply-0-transformed, validate-CI-gap. - Rewrite report-formats.md: format comparison table, when-to-use prose for each format, GitHub Code Scanning SARIF upload example. - Expand configuration.md openFeatureClientBindings: what it does, example, multiple bindings, difference from wrappers. Signed-off-by: Krishan Kant Sharma <krishansharma0327@gmail.com>
Fix 1/2: Remove React SDK from 'does not detect' list in index.md and quickstart.md — hooks/HOC/provider detected since v1.1.0. Update limitations.md to clarify detected-but-not-auto-migrated status. Fix 3: Add 'version' input row to GitHub Actions options table and add version-pinning example. Fix 4: Set Start Here sidebar section collapsed: false — new users must see the entry point without having to manually open it. Fix 5/7: Move Blog to bottom of sidebar, Trust just above it — docs content should dominate prime sidebar real estate. Fix 6: Move Concepts before Tutorials — users need conceptual grounding before tutorial steps make sense. Fix 8: Replace incomprehensible scan exit behavior prose with a clear exit code table matching the pattern used by validate.md. Fix 9: Add Type column to configuration fields table — users need to know whether minFileCount is a number, string, or boolean. Fix 10: Add Next link to completion.md — navigation was dead-ending. Fix 11: Standardize all quickstart commands to npx flaglint@latest. Fix 12: Bulk-fix 29 pages with wrong edit-this-page links pointing to flaglint/flaglint repo — corrected to flaglint/flaglint.dev. Signed-off-by: Krishan Kant Sharma <krishansharma0327@gmail.com>
Deploying flaglint with
|
| Latest commit: |
5a4cb25
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://3c0cc808.flaglint.pages.dev |
| Branch Preview URL: | https://docs-quick-wins.flaglint.pages.dev |
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (36)
📝 WalkthroughWalkthroughThis PR reorders the Starlight sidebar in ChangesSidebar Navigation
Estimated code review effort: 2 (Simple) | ~15 minutes Documentation Content and Link Migration
Estimated code review effort: 3 (Moderate) | ~25 minutes Possibly related PRs
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes 3 ship-blocking accuracy bugs and 12 UX quick wins from the expert docs audit.
Accuracy fixes
versioninput to options table with pinning exampleSidebar improvements
collapsed: false— was hidden by default, breaking new-user onboardingCLI page improvements
Consistency
npx flaglint@latestthroughout quickstartTest plan
Summary by CodeRabbit